<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_streambuf_ref::mutable_buffers_type</title>
<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../basic_streambuf_ref.html" title="basic_streambuf_ref">
<link rel="prev" href="max_size.html" title="basic_streambuf_ref::max_size">
<link rel="next" href="prepare.html" title="basic_streambuf_ref::prepare">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="max_size.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_streambuf_ref.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="prepare.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.basic_streambuf_ref.mutable_buffers_type"></a><a class="link" href="mutable_buffers_type.html" title="basic_streambuf_ref::mutable_buffers_type">basic_streambuf_ref::mutable_buffers_type</a>
</h4></div></div></div>
<p>
          <a class="indexterm" name="boost_asio.indexterm.basic_streambuf_ref.mutable_buffers_type"></a> 
The
          type used to represent the output sequence as a list of buffers.
        </p>
<pre class="programlisting">typedef basic_streambuf&lt; Allocator &gt;::mutable_buffers_type mutable_buffers_type;
</pre>
<h6>
<a name="boost_asio.reference.basic_streambuf_ref.mutable_buffers_type.h0"></a>
          <span class="phrase"><a name="boost_asio.reference.basic_streambuf_ref.mutable_buffers_type.types"></a></span><a class="link" href="mutable_buffers_type.html#boost_asio.reference.basic_streambuf_ref.mutable_buffers_type.types">Types</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Name
                  </p>
                </th>
<th>
                  <p>
                    Description
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    <a class="link" href="../basic_streambuf/const_buffers_type.html" title="basic_streambuf::const_buffers_type"><span class="bold"><strong>const_buffers_type</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    The type used to represent the input sequence as a list of buffers.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="../basic_streambuf/mutable_buffers_type.html" title="basic_streambuf::mutable_buffers_type"><span class="bold"><strong>mutable_buffers_type</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    The type used to represent the output sequence as a list of buffers.
                  </p>
                </td>
</tr>
</tbody>
</table></div>
<h6>
<a name="boost_asio.reference.basic_streambuf_ref.mutable_buffers_type.h1"></a>
          <span class="phrase"><a name="boost_asio.reference.basic_streambuf_ref.mutable_buffers_type.member_functions"></a></span><a class="link" href="mutable_buffers_type.html#boost_asio.reference.basic_streambuf_ref.mutable_buffers_type.member_functions">Member
          Functions</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Name
                  </p>
                </th>
<th>
                  <p>
                    Description
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    <a class="link" href="../basic_streambuf/basic_streambuf.html" title="basic_streambuf::basic_streambuf"><span class="bold"><strong>basic_streambuf</strong></span></a> <span class="silver">[constructor]</span>
                  </p>
                </td>
<td>
                  <p>
                    Construct a basic_streambuf object.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="../basic_streambuf/capacity.html" title="basic_streambuf::capacity"><span class="bold"><strong>capacity</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Get the current capacity of the basic_streambuf.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="../basic_streambuf/commit.html" title="basic_streambuf::commit"><span class="bold"><strong>commit</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Move characters from the output sequence to the input sequence.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="../basic_streambuf/consume.html" title="basic_streambuf::consume"><span class="bold"><strong>consume</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Remove characters from the input sequence.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="../basic_streambuf/data.html" title="basic_streambuf::data"><span class="bold"><strong>data</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Get a list of buffers that represents the input sequence.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="../basic_streambuf/max_size.html" title="basic_streambuf::max_size"><span class="bold"><strong>max_size</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Get the maximum size of the basic_streambuf.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="../basic_streambuf/prepare.html" title="basic_streambuf::prepare"><span class="bold"><strong>prepare</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Get a list of buffers that represents the output sequence, with
                    the given size.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="../basic_streambuf/size.html" title="basic_streambuf::size"><span class="bold"><strong>size</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Get the size of the input sequence.
                  </p>
                </td>
</tr>
</tbody>
</table></div>
<h6>
<a name="boost_asio.reference.basic_streambuf_ref.mutable_buffers_type.h2"></a>
          <span class="phrase"><a name="boost_asio.reference.basic_streambuf_ref.mutable_buffers_type.protected_member_functions"></a></span><a class="link" href="mutable_buffers_type.html#boost_asio.reference.basic_streambuf_ref.mutable_buffers_type.protected_member_functions">Protected
          Member Functions</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Name
                  </p>
                </th>
<th>
                  <p>
                    Description
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    <a class="link" href="../basic_streambuf/overflow.html" title="basic_streambuf::overflow"><span class="bold"><strong>overflow</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Override std::streambuf behaviour.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="../basic_streambuf/reserve.html" title="basic_streambuf::reserve"><span class="bold"><strong>reserve</strong></span></a>
                  </p>
                </td>
<td>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="../basic_streambuf/underflow.html" title="basic_streambuf::underflow"><span class="bold"><strong>underflow</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Override std::streambuf behaviour.
                  </p>
                </td>
</tr>
</tbody>
</table></div>
<p>
          The <code class="computeroutput">basic_streambuf</code> class is derived from <code class="computeroutput">std::streambuf</code>
          to associate the streambuf's input and output sequences with one or more
          character arrays. These character arrays are internal to the <code class="computeroutput">basic_streambuf</code>
          object, but direct access to the array elements is provided to permit them
          to be used efficiently with I/O operations. Characters written to the output
          sequence of a <code class="computeroutput">basic_streambuf</code> object are appended to the input
          sequence of the same object.
        </p>
<p>
          The <code class="computeroutput">basic_streambuf</code> class's public interface is intended to
          permit the following implementation strategies:
        </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
              A single contiguous character array, which is reallocated as necessary
              to accommodate changes in the size of the character sequence. This
              is the implementation approach currently used in Asio.
            </li>
<li class="listitem">
              A sequence of one or more character arrays, where each array is of
              the same size. Additional character array objects are appended to the
              sequence to accommodate changes in the size of the character sequence.
            </li>
<li class="listitem">
              A sequence of one or more character arrays of varying sizes. Additional
              character array objects are appended to the sequence to accommodate
              changes in the size of the character sequence.
            </li>
</ul></div>
<p>
          The constructor for <a class="link" href="../basic_streambuf.html" title="basic_streambuf"><code class="computeroutput">basic_streambuf</code></a>
          accepts a <code class="computeroutput">size_t</code> argument specifying the maximum of the sum
          of the sizes of the input sequence and output sequence. During the lifetime
          of the <code class="computeroutput">basic_streambuf</code> object, the following invariant holds:
        </p>
<pre class="programlisting">size() &lt;= max_size()
</pre>
<p>
          Any member function that would, if successful, cause the invariant to be
          violated shall throw an exception of class <code class="computeroutput">std::length_error</code>.
        </p>
<p>
          The constructor for <code class="computeroutput">basic_streambuf</code> takes an Allocator argument.
          A copy of this argument is used for any memory allocation performed, by
          the constructor and by all member functions, during the lifetime of each
          <code class="computeroutput">basic_streambuf</code> object.
        </p>
<h6>
<a name="boost_asio.reference.basic_streambuf_ref.mutable_buffers_type.h3"></a>
          <span class="phrase"><a name="boost_asio.reference.basic_streambuf_ref.mutable_buffers_type.examples"></a></span><a class="link" href="mutable_buffers_type.html#boost_asio.reference.basic_streambuf_ref.mutable_buffers_type.examples">Examples</a>
        </h6>
<p>
          Writing directly from an streambuf to a socket:
        </p>
<pre class="programlisting">boost::asio::streambuf b;
std::ostream os(&amp;b);
os &lt;&lt; "Hello, World!\n";

// try sending some data in input sequence
size_t n = sock.send(b.data());

b.consume(n); // sent data is removed from input sequence
</pre>
<p>
          Reading from a socket directly into a streambuf:
        </p>
<pre class="programlisting">boost::asio::streambuf b;

// reserve 512 bytes in output sequence
boost::asio::streambuf::mutable_buffers_type bufs = b.prepare(512);

size_t n = sock.receive(bufs);

// received data is "committed" from output sequence to input sequence
b.commit(n);

std::istream is(&amp;b);
std::string s;
is &gt;&gt; s;
</pre>
<h6>
<a name="boost_asio.reference.basic_streambuf_ref.mutable_buffers_type.h4"></a>
          <span class="phrase"><a name="boost_asio.reference.basic_streambuf_ref.mutable_buffers_type.requirements"></a></span><a class="link" href="mutable_buffers_type.html#boost_asio.reference.basic_streambuf_ref.mutable_buffers_type.requirements">Requirements</a>
        </h6>
<p>
          <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_streambuf.hpp</code>
        </p>
<p>
          <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
        </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2021 Christopher
      M. Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="max_size.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_streambuf_ref.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="prepare.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
